[misc] Properly format subheadings and code in gen_blog_post_html.py #18311
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Our Changelog is uses 3 number signs (#) for subheadings, not 4. This should generate proper `<h3>` in the blog post. Also, code blocks are generate with just `<pre>` tags. Let's also add `<code>` tags so we can potentially apply syntax highlighting with js like highlight.js in the future, if we want to.
JukkaL
approved these changes
Dec 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Our Changelog uses 3 number signs (#) for subheadings, not 4. This should generate proper
<h3>in the blog post.Also, code blocks are generated with just
<pre>tags. Let's also add<code>tags so we can potentially apply syntax highlighting with js like highlight.js in the future, if we want to.highlight.js detects
<pre><code> ... </code></pre>. We can also put the language, but it detects it automatically: https://highlightjs.readthedocs.io/en/latest/readme.html#in-the-browser